<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pymunk</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar">
  <tr valign="middle">
  <!-- Project homepage -->
      <!--<th class="navbar" 
            ><a class="navbar" target="_top" href="http://pymunk.googlecode.com/">pymunk API reference</a></th>-->

  <!-- Tree link -->
      <th><a
        href="module-tree.html">Trees</a></th>

  <!-- Index link -->
      <th><a
        href="identifier-index.html">Indices</a></th>

  <!-- Breadcrumbs -->
      <th class="navbar-breadcrumbs">
        <span class="breadcrumbs">
          pymunk
        </span>
      </th>

      <th class="navbar last">
        <a href="javascript:toggleFrames()">Toggle&nbsp;frames</a>
      </th>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package pymunk</h1>
<p>pymunk is a python wrapper for the 2d physics library Chipmunk</p>
<p>IRC: #pymunk on irc.freenode.net</p>
<p>Homepage: <a class="rst-reference" href="http://pymunk.googlecode.com/" target="_top">http://pymunk.googlecode.com/</a></p>
<p>Forum: <a class="rst-reference" href="http://www.slembcke.net/forums/viewforum.php?f=6" target="_top">http://www.slembcke.net/forums/viewforum.php?f=6</a></p>

<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
        <h2>Submodules</h2>
<table class="summary">
<tr><td width="15%"></td><td><a href="pymunk.util-module.html" class="summary-name">pymunk.util</a><div class="summary-description">Contains utility functions, mainly to help with polygon creation</div></td></tr><tr><td width="15%"></td><td><a href="pymunk.vec2d-module.html" class="summary-name">pymunk.vec2d</a></td></tr></table>
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
        <h2>Classes</h2>
<table class="summary">
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Space-class.html" class="summary-name">Space</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Body-class.html" class="summary-name">Body</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Shape-class.html" class="summary-name">Shape</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Circle-class.html" class="summary-name">Circle</a>
<div class="summary-description">A circle shape defined by a radius</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Segment-class.html" class="summary-name">Segment</a>
<div class="summary-description">A line segment shape between two points
This shape is mainly intended as a static shape.</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Poly-class.html" class="summary-name">Poly</a>
<div class="summary-description">A polygon shape</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Joint-class.html" class="summary-name">Joint</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.PinJoint-class.html" class="summary-name">PinJoint</a>
<div class="summary-description">Keeps the anchor points at a set distance from one another.</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.SlideJoint-class.html" class="summary-name">SlideJoint</a>
<div class="summary-description">Like pin joints, but have a minimum and maximum distance.</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.PivotJoint-class.html" class="summary-name">PivotJoint</a>
<div class="summary-description">Simply allow two objects to pivot about a single point.</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.GrooveJoint-class.html" class="summary-name">GrooveJoint</a>
<div class="summary-description">Similar to a pivot joint, but one of the anchors is
on a linear slide instead of being fixed.</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Contact-class.html" class="summary-name">Contact</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk.Arbiter-class.html" class="summary-name">Arbiter</a>
<div class="summary-description">Class for tracking collisions between shapes.</div>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
        <h2>Functions</h2>
<table class="summary">
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <span class="summary-sig"><a name="init_pymunk"></a><span class="summary-sig-name">init_pymunk</span>()</span>
<div class="summary-description">Call this method to initialize pymunk</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <span class="summary-sig"><a name="moment_for_circle"></a><span class="summary-sig-name">moment_for_circle</span>(<span class="summary-sig-arg">mass</span>,
        <span class="summary-sig-arg">inner_radius</span>,
        <span class="summary-sig-arg">outer_radius</span>,
        <span class="summary-sig-arg">offset</span>)</span>
<div class="summary-description">Calculate the moment of inertia for a circle</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <span class="summary-sig"><a name="moment_for_poly"></a><span class="summary-sig-name">moment_for_poly</span>(<span class="summary-sig-arg">mass</span>,
        <span class="summary-sig-arg">vertices</span>,
        <span class="summary-sig-arg">offset</span>)</span>
<div class="summary-description">Calculate the moment of inertia for a polygon</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <span class="summary-sig"><a name="reset_shapeid_counter"></a><span class="summary-sig-name">reset_shapeid_counter</span>()</span>
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
        <h2>Variables</h2>
<table class="summary">
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk-module.html#version" class="summary-name">version</a> = <code title="'0.7'"><code class="variable-quote">'</code><code class="variable-string">0.7</code><code class="variable-quote">'</code></code>
<div class="summary-description">The release version of this pymunk installation</div>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pymunk-module.html#inf" class="summary-name">inf</a> = <code title="1e+100">1e+100</code>
<div class="summary-description">Infinity that can be passed as mass or inertia to Body</div>
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
        <h2>Variables Details</h2>
<table class="details">
</table>
<a name="version"></a>
<div class=" detail">
  <h3>version</h3>
  <div class="detail-description">
  <p>The release version of this pymunk installation</p>
<p>Valid only if pymunk was installed from a source or binary
distribution (i.e. not in a checked-out copy from svn).</p>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">0.7</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
  </div>
</div>
<a name="inf"></a>
<div class=" detail">
  <h3>inf</h3>
  <div class="detail-description">
  <p>Infinity that can be passed as mass or inertia to Body</p>
<p>Use this as mass and inertia when you need to create a static body.</p>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
1e+100
</pre></td></tr></table>
</dd>
  </dl>
  </div>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar">
  <tr valign="middle">
  <!-- Project homepage -->
      <!--<th class="navbar" 
            ><a class="navbar" target="_top" href="http://pymunk.googlecode.com/">pymunk API reference</a></th>-->

  <!-- Tree link -->
      <th><a
        href="module-tree.html">Trees</a></th>

  <!-- Index link -->
      <th><a
        href="identifier-index.html">Indices</a></th>

  <!-- Breadcrumbs -->
      <th class="navbar-breadcrumbs">
        <span class="breadcrumbs">
          pymunk
        </span>
      </th>

      <th class="navbar last">
        <a href="javascript:toggleFrames()">Toggle&nbsp;frames</a>
      </th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Wed Apr 30 17:58:44 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
